package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AttendanceDedProgAddDTO;
import org.jsola.hr.dto.AttendanceDedProgUpdateDTO;
import org.jsola.hr.query.AttendanceDedProgQuery;
import org.jsola.hr.vo.AttendanceDedProgListVO;
import org.jsola.hr.vo.AttendanceDedProgVO;

import javax.validation.Valid;
import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-员工考勤扣款方案")
public interface IAttendanceDedProgControllerAPI {

    /**
     * 新增员工考勤扣款方案
     * @param attendanceDedProgAddDTO 员工考勤扣款方案新增实体
     * @return 员工考勤扣款方案展示对象
     */
    @ApiOperation(value = "新增员工考勤扣款方案")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedProgAddDTO", dataType = "AttendanceDedProgAddDTO", value = "新增员工考勤扣款方案", paramType = "body")
    })
    Result<AttendanceDedProgVO> save(AttendanceDedProgAddDTO attendanceDedProgAddDTO);


    /**
     * 修改员工考勤扣款方案
     * @param attendanceDedProgUpdateDTO 员工考勤扣款方案
     * @return 更新数量
     */
    @ApiOperation(value = "修改员工考勤扣款方案")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedProgUpdateDTO", dataType = "AttendanceDedProgUpdateDTO", value = "修改员工考勤扣款方案", paramType = "body")
    })
    Result<Integer> update(AttendanceDedProgUpdateDTO attendanceDedProgUpdateDTO);




    /**
     * 删除单个员工考勤扣款方案，彻底删除
     * @param attendanceDedProgId 员工考勤扣款方案id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个员工考勤扣款方案，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedProgId", dataType = "String", value = "员工考勤扣款方案id", paramType = "path")
    })
    Result<Integer> delete(String attendanceDedProgId);


    /**
     * 批量删除员工考勤扣款方案，彻底删除
     * @param attendanceDedProgIds 员工考勤扣款方案id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除员工考勤扣款方案，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedProgIds", dataType = "String[]", value = "员工考勤扣款方案id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] attendanceDedProgIds);


    /**
     * 根据员工考勤扣款方案id查询员工考勤扣款方案详情
     * @param attendanceDedProgId 员工考勤扣款方案id
     * @return 员工考勤扣款方案详情
     */
    @ApiOperation(value="根据员工考勤扣款方案id查询员工考勤扣款方案详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedProgId", dataType = "String", value = "员工考勤扣款方案id", paramType = "path")
    })
    Result<AttendanceDedProgVO> findById(String attendanceDedProgId);


    /**
     * 查询员工考勤扣款方案
     * @param attendanceDedProgQuery 员工考勤扣款方案查询参数
     * @return page
     */
    @ApiOperation(value="查询员工考勤扣款方案")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedProgQuery", dataType = "AttendanceDedProgQuery", value = "员工考勤扣款方案查询参数", paramType = "query")
    })
    Result<List<AttendanceDedProgListVO>> listAll(AttendanceDedProgQuery attendanceDedProgQuery);


     /**
     * 分页查询员工考勤扣款方案
     * @param attendanceDedProgQuery 员工考勤扣款方案查询参数
     * @return page
     */
    @ApiOperation(value="分页查询员工考勤扣款方案")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendanceDedProgQuery", dataType = "AttendanceDedProgQuery", value = "员工考勤扣款方案查询参数", paramType = "query")
    })
    Result<Page<AttendanceDedProgListVO>> page(AttendanceDedProgQuery attendanceDedProgQuery);

    /**
     * 查询员工考勤扣款方案列表
     * @param companyId 公司ID
     * @return 员工考勤扣款方案列表
     */
    @ApiOperation(value="查询员工考勤扣款方案列表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyId", dataType = "String", value = "公司ID", paramType = "query")
    })
    Result<List<AttendanceDedProgListVO>> selectListAll(@Valid String companyId);

    /**
     * 查询员工考勤扣款方案相关
     * @param id 员工考勤扣款方案ID
     * @return 员工考勤扣款方案列表
     */
    @ApiOperation(value="查询员工考勤扣款方案相关")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", dataType = "String", value = "员工考勤扣款方案ID", paramType = "query")
    })
    Result<AttendanceDedProgVO> selectRelationById(@Valid String id);


}

